home *** CD-ROM | disk | FTP | other *** search
/ The Very Best of Atari Inside / The Very Best of Atari Inside 1.iso / pofo / applicat.ion / vde15 / vinst15.doc < prev    next >
Text File  |  1991-08-21  |  40KB  |  695 lines
  1.  
  2.  
  3.                                  VINST15.DOC
  4.                                  ----------- 
  5.                           [Supplement to VDE15.DOC]
  6.  
  7.                  Instructions for Macros and VINSTALL utility
  8.  
  9.                             (c)1987-89 Eric Meyer
  10.  
  11.  
  12. ================================  CONTENTS  ==================================
  13.                                  (continued)
  14.  
  15. 6. MACROS.  Explanation and examples of:
  16.         Function keys, Key redefinition files, Macros, Macro keys, Macro
  17.      programming, Recording macros.
  18.  
  19. 7. RUNNING VINSTALL.  How to use VINST.COM to modify VDE.COM.:
  20.  
  21.    A. INSTALLATION.  Installing for different computer hardware:
  22.       ============   Screen size; IBM compatibility; Colors; Fonts; Snow.
  23.  
  24.    B. USER OPTIONS.  Customization of many initial VDE settings.
  25.  
  26.    C. PRINTER INSTALLATION.  Using special printer features:
  27.                           print modes, graphics, etc.
  28.  
  29.    D. DEFAULT MACRO KEYS.  Installing a default set of macro keys.
  30.  
  31.    E. DEFAULT FUNCTION KEYS.  Installing the function keys.
  32.  
  33.    F. GRAPHICS.  Modifying the default set of graphics characters.
  34.  
  35.    G. RESTORE DEFAULTS.  Undoing previous modifications.
  36.  
  37.  
  38.  
  39.  
  40. ================================  6. MACROS  =================================
  41.                              (Command mode only)
  42.  
  43.      Macros are a sophisticated and powerful tool for automating repetitive 
  44. tasks.  A "macro" is a string of VDE commands and/or text that you can type in 
  45. once and then have repeated automatically.  (Note: for large pieces of boiler- 
  46. plate text, read in disk files with ^KR instead.)  A "function key" is a macro 
  47. assigned to one of the [F1]...[F40] keys, while a "macro key" is a macro 
  48. assigned to a key Esc0...9 or EscA...Z; these can all be defined either while 
  49. editing, or with VINSTALL.  "Macro programming" involves the use of special 
  50. commands allowing a macro to perform more complex operations including loops 
  51. and conditional execution, much like a programming language.
  52.      VDE's 76 user-definable macros allow you to customize it for any task, 
  53. such as the formatting requirements of specialized professional writing, or 
  54. many programming languages.  Many examples are given below.
  55.      To create a macro, while editing, you can:
  56.          (1) use the Esc[ command, and type the necessary keystrokes at the 
  57.     prompt.  You may want to plan or compose the macro first, using pen and 
  58.     paper.  Certain keystrokes, like [Ret] or ^X, are line editing commands, 
  59.     and must be preceded by a ^P to enter them into the macro; the input line 
  60.     has a 65-key limit.  See MACROS, PROMPTS.
  61.          (2) use the Esc" command.  Type the desired keystrokes, exactly as 
  62.     you would while editing: no ^P prefixes are required, and you will see the 
  63.     results as you type.  There is a 128-key limit.  See RECORDING MACROS.
  64.  
  65.      Macros execute EXACTLY as though you had typed the given keys yourself.  
  66. EXAMPLE: to read in a letterhead file called LETTER.HDR at the top of your 
  67. file, you would type:
  68.               ^QR         to get to the top of the file
  69.               ^KR         to read in a file
  70.               LETTER.HDR  to specify filename at the "Read file:" prompt
  71.               [Ret]       to end the filename input
  72. So this is exactly what you need to enter in your macro.  Note that ALL the 
  73. input -- every keystroke, including answers to prompts, [Ret] keystrokes, and 
  74. so on -- MUST be included.  For further details see MACROS.
  75.  
  76.      Once again, ordinarily macros are completely self-contained, and NEVER 
  77. request input from the keyboard while running.  There are two exceptions:
  78.          (1) If a reformat (^B) operation is in progress and 
  79.       dehyphenation is required, the "Remove?" prompt will appear in 
  80.       the header and a "Y/N" answer will be necessary to continue.  
  81.       (This is a decision the macro can't make.)  See REFORMAT.
  82.          (2) Using the AltR command in macros is tricky: input while 
  83.       running a program must come from the keyboard.  (At that point 
  84.       VDE is no longer in control.)  See RUN COMMAND.
  85.  
  86.  
  87.                                  USING MACROS
  88.  
  89. FUNCTION KEYS ([F1]...[F40]) -  Up to 40 macros can be assigned to function 
  90.     keys; they can then be recalled and used with one keystroke.  Each of the 
  91.     10 function keys can be used with Shift, Ctrl, or Alt, to produce:
  92.               Shift-[F1]...[F10]  =  [F11]...[F20]
  93.                Ctrl-[F1]...[F10]  =  [F21]...[F30]
  94.                 Alt-[F1]...[F10]  =  [F31]...[F40]
  95.     The new Extended (101-key) keyboards actually have extra keys labeled 
  96.     [F11] and [F12]; VDE will not recognize these keys.
  97.          Otherwise, function keys are defined (with the Esc] command, or with 
  98.     VINSTALL) and used exactly like macro keys.  See MACRO KEYS.
  99.  
  100. KEY DEFINITION FILES (AltU) -  These files save sets of macro key or function 
  101.     key definitions, and should be given file types of ".VDK" and ".VDF", 
  102.     respectively.  You can load any key file, along with your text file to 
  103.     edit, from the command line (see SYNTAX).  In addition, they can be loaded 
  104.     or saved with the AltU command while editing in VDE, and can also be 
  105.     created or installed as defaults in your copy of VDE with the VINSTALL 
  106.     program (see below).
  107.          The AltU command will ask whether you want to "L"oad or "S"ave such a 
  108.     file, then prompt for the name of the file.  The filetype MUST be ".VDK" 
  109.     or ".VDF", and will determine whether MACRO or FUNCTION keys are affected.  
  110.     If you load such a file, those definitions will replace any previous ones.  
  111.     If you save, the current definitions will be written to the file.
  112.  
  113. MACROS (Esc[) -  When you are in the middle of doing something in VDE, and 
  114.     find that you need to do something many times, it may be less tedious to 
  115.     have it repeated automatically.  If you type Esc[ you will be asked for 
  116.     the string to execute, then a "Repeat count".  Usually you will simply 
  117.     type a number for the repeat count (0-254, or "*" for indefinite).  You 
  118.     will see the results as the macro executes, and you can abort it at any 
  119.     time by pressing Esc.
  120.          (You can speed up macro execution by specifying "Quiet" mode: type 
  121.     "^Q" before the repeat count.  Only the header will be updated as the 
  122.     macro runs.  Don't do this if the macro concludes by requesting user input 
  123.     -- the necessary prompts would not display!)
  124.          Macros also stop any time an error occurs; the error message will be 
  125.     visible, and can be cleared by pressing Esc.  Many commands (like Find or 
  126.     Reformat) are designed to generate errors at the end of the file so that 
  127.     an indefinite ("*") macro containing them will halt there.  Other indef- 
  128.     inite macros may need to be aborted manually.
  129.          VDE turns INSERT OFF before running a macro, so that the same 
  130.     sequence will always have the same effect.  The INSERT status is restored 
  131.     when the macro terminates.  (To insert text with a macro, use ^V.)
  132.          In order to include any input line editing characters (BS (^H), [Ret] 
  133.     (^M), ^J, ^X, ^U, ^P) in a macro, you must prefix them with ^P.  (NOTE:  
  134.     To make them easier to read and understand, macro listings will be given 
  135.     here as they function, not as they are typed in.  ^P prefixes as needed 
  136.     are NOT shown: remember that you need to add them!  Keystrokes are often 
  137.     separated by spaces for clarity; the "_" symbol is used to represent an 
  138.     actual space character typed.  Here are some sample macros:
  139.          1.  Reformat an entire file (Wordstar ^QQB): after Esc[, just enter
  140.                                   ^B
  141.     Specify quiet and indefinite repeat as options ("Q*").
  142.          2.  View a file by scrolling slowly through it:
  143.                                Esc; ^C
  144.     This will pause, then scroll down.  (Use a repeat count of "*".)
  145.          3.  Enter a long graphics border for a box.  (This can get tedious by 
  146.     hand.)  Assuming graphic "Y" is the horizontal bar,
  147.                                AltG Y
  148.     will enter one character.  You can get a line 40 characters long by giving 
  149.     a repeat count of "^Q40" (the "^Q"uiet option avoids unnecessarily 
  150.     displaying the menu).
  151.          4.  Can you figure out what this one does, if entered with a repeat 
  152.     count of "*"?  (Answer:  .elif eht fo dne eht ta meht fo tsil a gnikam 
  153.     elif a fo tuo sesehtnerap ni stnemmoc ekat lliw tI)
  154.                 ^QR ^QF(^J ^G ^KB ^QF)^J ^G ^KK ^QC [Ret] ^KV
  155.          VDE macros are very powerful tools, particularly given their program 
  156.     ability and storage on macro Keys.
  157.  
  158. MACRO KEYS (Esc],0...Z) -  Up to 36 macros can be stored (0...9,A...Z), by 
  159.     entering them with the Esc[ command, then using Esc] to save them.  They 
  160.     can then be recalled and used with two keystrokes.  Example: typing Esc]3 
  161.     will store the last macro used as key 3, and it can be recalled and reused 
  162.     at any future time simply by typing Esc3.
  163.          Ordinarily, macro keys operate just like the original macro:  they 
  164.     will ask for a "Repeat count" when executed.  In many cases, you will want 
  165.     a key to execute only once when invoked; you can make a key "No-repeat" by 
  166.     typing ^N before the keycode.  Example: Esc]^N3 stores a macro to key 3 as 
  167.     a non-repeating sequence.  If you want the key to run in Quiet mode as 
  168.     well (to increase speed and minimize display activity), you can instead 
  169.     type ^Q: Esc]^Q3 stores a quiet, non-repeating sequence.
  170.          Using a defined key brings its definition into the macro buffer 
  171.     (whence it can be stored again, if desired).  Trying to use an undefined 
  172.     key results in an error.  You can delete a key definition by entering an 
  173.     empty macro string (Esc[, return) and storing it to the key.
  174.          There is a total of 982 bytes available for all 36 keys, and a 128 
  175.     byte limit for any one key.  (VDE's own input line will only accept 65 
  176.     bytes, but VINSTALL can handle up to the full 128.)
  177.          EXAMPLES: Besides simply storing any macro, these Keys are useful for 
  178.     storing a frequently repeated phrase; "EscW" is much more convenient than 
  179.     "World Wide Widgets Ltd. (N.A.)".  You might also define one as a common 
  180.     command like ^PS, for underlining; or a set of margins, like ^OR60[Ret] 
  181.     ^OL5[Ret].  A key defined as ^QR ^N AltD ^OF would place the current date 
  182.     at the top right of a letter.
  183.          Keys defined with Esc] are of course temporary.  (VINSTALL allows you 
  184.     to install them permanently; see DEFAULT FUNCTION KEYS.)
  185.  
  186. MACRO PROGRAMMING (Esc0...Z,!,=,~,(),+,-,&,;) -  VDE has several commands that 
  187.     operate only in a macro string, and give you conditional control over the 
  188.     execution of a macro, allowing real programming.
  189.          Esc0...Z, when in a macro, function simply as "labels" 0...Z.  They 
  190.     have no effect, but can be "jumped" to by other commands.
  191.          Esc! followed by 0...Z is a simple "jump" instruction, causing macro 
  192.     execution to resume with the command following the label Esc0...Z.  
  193.     Example: Esc!2 jumps to label 2.  As two special cases, Esc![ jumps to the 
  194.     beginning of the macro, and Esc!] jumps to the end (aborts).
  195.          Esc= and Esc~, followed by a character and then a label 0...Z (or 
  196.     "[","]"), are conditional jumps: they jump to that label IF the character 
  197.     at the cursor position does (or for "~", doesn't) match that specified. 
  198.     Example: Esc~^M2 jumps to label 2 if the current character is NOT a CR.
  199.          Esc= and Esc~, followed by a character and then ">" or "<", are 
  200.     search loops.  They will continue to move the cursor right (or for "<", 
  201.     left) as long as the character at the cursor does (or for "~", doesn't) 
  202.     match, or until the beginning or end of the file.  Example: Esc=_> moves 
  203.     right as long as the current character is a space.
  204.          Several commands allow the use of a counter variable.  Esc() sets 
  205.     the value: for example, Esc(0) initializes it to zero.  The Esc+ command 
  206.     simply increments the value; Esc- (that's Esc,minus) decrements the value, 
  207.     then jumps if it is zero to a specified label.  (In addition to a number, 
  208.     you may use "[" or "]" for the start or end of the macro, or "@" to avoid 
  209.     jumping entirely.)  Example: Esc-] decrements the counter, jumping to the 
  210.     end (exiting) if it reaches zero.
  211.          Esc&, followed by 0...Z, is used to "chain" to another macro key.  In 
  212.     this way you can build up strings longer than the 65/128-byte limit on any 
  213.     one key.  It does not "call" the key; there is no returning.  Example: 
  214.     Esc&M chains to key M.
  215.          Esc; (semicolon) gives a brief pause before execution continues, 
  216.     presumably so the user can see what's happening on screen.
  217.          Macro programs are stored just like any other macro string (usually 
  218.     as No-repeat).  If you program an endless loop, you will at some point 
  219.     have to abort by pressing Esc.  Don't make macro programs Quiet until 
  220.     you're sure they work.
  221.          EXAMPLE 1: here is a good macro program (best stored as a Quiet key) 
  222.     to move the cursor to the start of the current sentence:
  223.                  Esc~.1 ^S Esc1 Esc~.< Esc2 ^D Esc=_2 Esc=^M2
  224.     You could write this out in programmer's pseudo-code as:
  225.               If not "." goto label1
  226.               Move left                 ;move left if already on period
  227.      label1:  While not "." move left   ;move left to previous period
  228.      label2:  Move right                ;now move back right
  229.               If " " goto label2        ;  as long as you see a space
  230.               If "^M" goto label2       ;  or a Return
  231.               (all done)
  232.          EXAMPLE 2: a macro to move to the start of the current paragraph:
  233.                  ^QS ^S^S Esc=_[ ^D^D
  234.          EXAMPLE 3: a macro to delete a word to the LEFT of the cursor:
  235.                  ^S Esc~_2 Esc1 ^G^S Esc=_1 Esc2 ^G^S Esc~_2 ^D
  236.          EXAMPLE 4: a macro to match parentheses.  Many programming languages 
  237.     use nested sets of parentheses, for example "{}" in C.  This program, when 
  238.     the cursor is placed on an open bracket, will move ahead to find the 
  239.     closed bracket that matches it:
  240.                  Esc~{] Esc(0) Esc1 Esc~{2 Esc+ Esc!3
  241.                                Esc2 Esc~}3 Esc-]
  242.                                Esc3 ^D Esc!1
  243.          EXERCISE: suppose you have a file captured from an online session 
  244.     with a remote system.  You corrected a lot of "misteaks" as you typed, 
  245.     using the Backspace key -- and now that's all in the file:
  246.                     I hardly ever make misteak^H^H^Hakes!
  247.     Write a macro program to go through the file and neaten those all up, 
  248.     deleting the erased characters along with the ^H's.
  249.  
  250. RECORDING MACROS (Esc") - As an alternative to composing macros and using the 
  251.     Esc[ command to type them in, you can simply record a macro from a 
  252.     sequence of keystrokes as you go about a task.  Press Esc" to activate 
  253.     recording; type away; then press Esc" again to conclude.  You will then be 
  254.     asked for the repeat count, etc (see MACROS).  No confusing ^P prefixes 
  255.     are needed, and you can take advantage of the full 128-key length limit.  
  256.     While recording, a quote mark (") will be visible in the upper right 
  257.     (prefix) area of the header, if the header is displayed.
  258.          Note: function and macro key commands will not work while macro 
  259.     recording is in progress.
  260.  
  261.  
  262. ==========================  7. RUNNING VINSTALL  =============================
  263.  
  264.  
  265.      VINSTALL is a utility that lets you customize your copy of the VDE 
  266. editor.  Most of this involves options that you need not concern yourself with 
  267. at first: in the course of using VDE, you will discover how you want these 
  268. things set.  However, there are important changes you will need to make to VDE 
  269. before using it, if you have a computer that:
  270.               * Is not fully IBM compatible (BIOS, video).
  271.               * Experiences "snow" problems with programs that write
  272.                  directly to video memory (older style CGA adapters).
  273.      An uninstalled copy of VDE will ask you whether it is running on an IBM 
  274. compatible computer.  Once you have used VINSTALL this message will disappear.
  275.  
  276.      Your copies of the program files will have names like VINST13.COM and 
  277. VDE13.COM.  Feel free to rename these to VINSTALL and VDE, as will be assumed 
  278. here (or to VI and V, as I do).  To run VINSTALL simply type:
  279. name of a copy of VDE to modify:
  280.               C>vinstall              if your copy is called "VDE.COM"
  281.         or    C>vinstall FILENAME     if it's called something else.
  282.      Notes: VINSTALL modifies the file VDE.COM; always keep an unmodified 
  283. original copy of all VDE files in case problems arise!  The version numbers of 
  284. VINSTALL and VDE (and any auxiliary key or printer files, see below) must 
  285. agree, or you will get an error.
  286.  
  287.      VINSTALL is fully menu-driven; it will present you with a set of 
  288. categories that corresponds to each section below, starting with Installation; 
  289. you select the values you want to change.  The program is largely self- 
  290. documenting, and steps you through each item individually.  If this is your 
  291. first time, take advantage of its "Help" option before you start in, for some 
  292. basic instructions.  You may also find a good ASCII chart helpful.  VINSTALL 
  293. uses several different types of data entry:
  294.      TEXT - Just type in the character(s).
  295.      LOGICAL - Yes/No.  Just type "Y" or "N".
  296.      DECIMAL - Enter a number from 0 to 255.
  297.      HEX - Enter a two-digit hex byte value 00-FF.  (Don't omit lead zeros.)
  298.      BYTE STRINGS - fixed length: enter the required number of hex bytes.
  299.                     variable: enter the (hex) count for the number of bytes, 
  300.               followed by the bytes themselves.  Example:  (02)1B3D.  The max- 
  301.               imum length is given in square brackets [#].  This format is 
  302.               referred to below as "(#),bytes".
  303. VINSTALL can't check for illegal values; be careful what you enter!
  304.  
  305.      At most points in VINSTALL, you can press Esc to return immediately to 
  306. the Main Menu, or ^C to abort the program.
  307.  
  308.  
  309. -----------------------------  A. INSTALLATION  ------------------------------
  310.  
  311.  
  312.      When you run VINSTALL on an uninstalled copy of VDE, this selection will 
  313. be made automatically.  You must describe the computer you are using: whether 
  314. 100% IBM PC compatible, or not.  (The HP Portable Plus is also supported.)
  315.      The IBM PC installation gives the best performance, but requires an IBM 
  316. standard BIOS and a supported video adapter (MDA,CGA,EGA,VGA).  You can 
  317. customize the display (colors, fonts etc) to your preferences.
  318.      The non-IBM installation will run on any system that supports ANSI 
  319. standard screen control sequences (eg, the ANSI.SYS screen driver -- you must 
  320. have the statement DEVICE=ANSI.SYS or equivalent in your CONFIG.SYS file).  
  321. You must also specify the size of your screen.  This installation can of 
  322. course be used on IBM compatibles, in the event that direct video access is 
  323. undesirable.  It will even work in "remote" applications, such as high-speed 
  324. modem connections, with appropriate terminal software on the user's end.
  325.  
  326. COMMON PARAMETERS:
  327.  
  328. Clock speed in MHz - Set this decimal value to reflect your CPU clock speed. 
  329.     Common values are 5 (for 4.77), 8, 10, 12, etc.  Adjust the value if 
  330.     desired to change the length of delays in VDE.  (At present this involves 
  331.     only the "Esc;" macro command.)
  332.  
  333. IBM PC PARAMETERS:
  334.  
  335. Screen colors - you can select six video attribute bytes: one for normal text; 
  336.     one for block text; one for soft CR markers; one for the header; one for 
  337.     menus and prompts; and one for highlights (prompts, etc). Each is two hex 
  338.     digits, for a background and foreground color.  You will see a color 
  339.     palette displayed on screen; the color digits are:
  340.            *0 = BLACK   4 = red      *8 = GREY       C = lt red
  341.             1 = blue    5 = magenta   9 = lt blue    D = lt magenta
  342.             2 = green   6 = brown     A = lt green   E = yellow
  343.             3 = cyan   *7 = WHITE     B = lt cyan   *F = BRIGHT WHITE
  344.     (* - All monochrome screens can display BLACK, WHITE, and BRIGHT WHITE; in 
  345.     some cases, GREY may also be visible.)
  346.          Any digit may be used for the the foreground, but only 0-7 for 
  347.     background (8-F produce blinking video...  ugh).  You will probably want 
  348.     the header and highlight attributes to have the same background.
  349.  
  350. Use VDE font in EGA mode (Y/N) - When the AltE command is used to display 43 
  351.     lines on an EGA (or 50 on VGA), you can choose one of two fonts.  VDE's 
  352.     own font is thinner than the ROM font, and you may find it more readable.  
  353.     "Y" selects this font; "N" selects the standard (fat) ROM font.
  354. Make cursor "D"efault,"B"lock,"U"nderline (D/B/U) - You can choose the cursor 
  355.     type you want during editing.  Choose "D"efault to leave it whatever it 
  356.     was before VDE was run.
  357. Snow removal (Y/N) - Normally No.  Some older CGA cards experience ugly "snow" 
  358.     when programs write directly to video memory.  If this happens to you, set 
  359.     this option to "Y", and VDE will time its video access according to 
  360.     horizontal retrace intervals.  (Display speed will be slightly reduced.)
  361.  
  362. NON-IBM PC PARAMETERS: (automatically set for IBM PC)
  363.  
  364. Terminal init - enter an optional string of code (#),bytes to be sent to the 
  365.     screen after clearing the screen, whenever (re)entering VDE.
  366. Terminal uninit - enter an optional string of code (#),bytes to be sent to the 
  367.     screen upon exiting from VDE back to DOS.
  368.  
  369. Viewable columns (80-255) - normally 80; set to the column width of your 
  370.     display, if different.
  371. Viewable lines (16-255) - normally 25; if you have a shorter or longer default 
  372.     display (on entry to VDE), enter the length here.
  373. Enable fast scroll (Y/N) - Does your computer respond to the ANSI sequences 
  374.     for insert/delete line (Esc-[-L,M)?  If so, set this to "Y" for a faster 
  375.     display.  (Default is "N", as MSDOS ANSI.SYS does not support these codes; 
  376.     some enhanced console drivers, such as NANSI.SYS, do.  The display will 
  377.     not work properly if you select "Y" with the standard ANSI.SYS.)
  378. Horizontal scroll delay (01-FF) - This hex parameter creates a delay between 
  379.     scrolling the cursor line and the rest of the screen, when the screen 
  380.     shifts horizontally (past column 80).  A moderate delay is useful if your 
  381.     screen display is slow, as it minimizes interference with typing.  The 
  382.     default value is 40; you can adjust this to suit your taste.  (01=minimal; 
  383.     FF=very long, almost suppressing full redisplay.)
  384.  
  385.  
  386. -----------------------------  B. USER OPTIONS  ------------------------------
  387.  
  388.  
  389.      You can change a variety of default settings in your copy of VDE, 
  390. according to your taste.  "Default" means the state assumed when VDE is first 
  391. run, or in the absence of any user commands.
  392.  
  393. Use COMMAND mode (Y/N) - Do you want VDE to use its WordStar-compatible 
  394.     command set?  If not, MenuBar mode is used.  See OPERATING MODES.
  395.  
  396. Autosave interval (min.) - Do you want VDE to save your work to disk auto- 
  397.     matically at intervals?  If so, enter the interval in minutes.  A value of 
  398.     0 turns this feature off.
  399. Preserve BAKup files (Y/N) - Should a backup file (*.BAK) be kept when you save 
  400.     over an existing file?  Choose "Y" to play safe, "N" to save disk space.
  401. Use ^Z as EOF mark (Y/N) - Should an EOF marker (^Z, 1Ah) be considered the 
  402.     end of a file?  MSDOS software should not require this, but some early 
  403.     programs (like their CP/M predecessors) did use this convention.  Normally 
  404.     set this to No: VDE will ignore ^Z on input, and will not add ^Z on 
  405.     output.  If set to Yes, VDE will consider a ^Z encountered on input as the 
  406.     end of the file, and will put ^Z at the end of each file on output.
  407. Exclude COM/EXE files (Y/N) - Normally "Y": executable programs (files with 
  408.     types of .COM or .EXE) will not show in the ^KF directory display (unless 
  409.     the filetype is specified explicitly), and cannot be edited.  This is a 
  410.     protection feature; you can damage such files by trying to edit them.  To 
  411.     disable, set to "N".
  412. File mode (W/A/N) -  Which of the three file modes "A","W","N" described in 
  413.     VDE.DOC do you want as the default?  (Originally "A".)
  414. Auto mode select filetypes - You can specify four filetypes (or type masks, 
  415.     using "?" wildcards) as exceptions to the above default: for example, you 
  416.     could declare all ".ASM" files to default automatically to "N" mode, or 
  417.     all files ".89?" to "W" mode.
  418.  
  419. Header on (Y/N) - Do you want the header (^OQ) to start out ON?  (Normally Yes)
  420. Ruler on (Y/N) - Do you want the Ruler (^OT) to start out ON?  (Normally No)
  421. Insert on (Y/N) - Do you want the INSERT (^V) toggle to start out ON?
  422. HCR display on (Y/N) - Do you want Hard CR display (^OB) to start out ON when 
  423.     editing a Document ("W,A" modes) with VDE?
  424. Hyphenation on (Y/N) - Do you want hyphenation (^OH) to start out ON?
  425. Case-insensitive search (Y/N) - Do you want string searches (^QF) to be case 
  426.     insensitive by default?  Normally, No; if Yes, specifying the "U"ppercase 
  427.     option will force a case SENSITIVE search.
  428.  
  429. Left and Right margin columns (1-255) - Default margin settings for "W/A" 
  430.     modes.  Set both to 1 to disable wordwrap and reformatting entirely.
  431. Reserve status line (Y/N) - Do you want VDE to reserve the bottom (normally 
  432.     25th) screen line for use as a status or function key line by special 
  433.     software?  (Normally No, VDE uses this line for text.)
  434. Scroll overlap (0-255) - This is the number of lines overlap between screens 
  435.     when scrolling: the smaller, the larger the scroll.  Originally set to 2, 
  436.     for a nearly full scroll.  Keep this smaller than your screen size!
  437.  
  438. Ring bell on error (Y/N) - Do you want the bell to ring when a VDE error 
  439.     message displays?
  440. [BkSp] (^H) deletes to left (Y/N) - Do you want the [BackSpace] (^H) key to 
  441.     delete characters?  Originally No - it just moves the cursor left.
  442. [Del] deletes to right (Y/N) - Do you want the [Delete] key to remove the char- 
  443.     acter to the right?  Originally No - it deletes to the left, as in 
  444.     WordStar.  (NOTE: whichever you choose, Ctrl-[Del] will do the opposite.)
  445. [Home,End] move left/right on line (Y/N) - Do you want the [Home] and [End] 
  446.     keys to move to the start or end of the line?  Originally No -- they move 
  447.     to the top or bottom of the screen, as in WordStar 4.
  448.  
  449. Variable tab stops -  Enter up to 8 variable tab stop columns, in ascending 
  450.     order.  Fill unused values with 0.  Defaults: 6, 15, 35, 55.  (Note: hard 
  451.     tabs are set at intervals of 8 columns, and cannot be adjusted.)
  452.  
  453. Show time as AM/PM, not 24 hr (Y/N) - Do you want the Time stamp to display in 
  454.     12 hour format (eg 1:21 PM)?  Originally Yes.  If No, the time shows in 24 
  455.     hour format (eg 13:21).
  456. European date format (day,month,yr) (Y/N) - Do you want the Date stamp to 
  457.     display in European format (eg 15.1.88 or 15 January 1988)?  Originally 
  458.     No, meaning US Format (eg 1/15/88 or January 15, 1988).
  459. Show date numerically (Y/N) - Do you want the Date stamp to display 
  460.     numerically (eg 1/15/88)?  Originally No, meaning verbose (eg January 15, 
  461.     1988).
  462.  
  463.  
  464. -------------------------  C. PRINTER INSTALLATION  --------------------------
  465.  
  466.  
  467.      Printers vary enormously.  VDE can accomodate two printer drivers, each 
  468. of which can be installed to take advantage of your printer's special 
  469. features.  (Within VDE, the AltV command can be used to select the driver to 
  470. use when printing.)  The defaults installed in VDE are a standard "IBM/Epson 
  471. FX" driver, and a "Simple" driver that can send plain text to any printer, but 
  472. does not support any print controls other than underline and strikeout.  These 
  473. and several other drivers can be selected from a menu within VINSTALL.  In 
  474. addition, you can create a driver to your printer manual's specifications.  
  475. (To modify the Alternate driver, you must temporarily make it the selected 
  476. one.)
  477.       NOTE: if you have a common printer that is not included in the 
  478.       menu, please send me the necessary data so that I can add it.
  479.  
  480.      VINSTALL can use special Printer Installation files to store and retrieve 
  481. other printer definitions.  These should have a file type of ".VDP".  You have 
  482. the option to read in or write out such a file, as well as editing the 
  483. following values individually.  This makes it easy to save your installation 
  484. and to pass it along to others.
  485.  
  486. Printer ID - Identify the printer you are installing.  (16 characters)
  487.  
  488. IBM graphics printer (Y/N) - Normally No; if you can print the IBM extended 
  489.     ASCII characters, set this to Yes.  If No, VDE will "emulate" graphics on 
  490.     printing, choosing standard character overstrikes that come close.
  491. Send LF after CR (Y/N) - Normally Yes.  But with some printers, which manufac- 
  492.     ture their own LF on receiving a CR, you will want No here.
  493.  
  494. Page length (0-255) - Set the number of text lines to print on a page.  (Does 
  495.     not include another 3 lines for a header or page number, if used.)
  496. Top margin (0-255) - Set the number of blank lines to skip as a top margin 
  497.     before printing each page.  This value (not included in the page length) 
  498.     can be used to position the paper properly.  Default is 0.
  499. Reserve space for header (Y/N) - Default is Yes; when printing without header 
  500.     or page number, 3 blank lines will be kept clear of text on each page, so 
  501.     that the physical page layout is the same.  If No, an additional 3 lines 
  502.     of text will print.
  503. Left margin (0-255) - Set the number of blank columns to skip as a left margin 
  504.     before printing each line.  Useful if you can't set the margin on your 
  505.     printer with an initialization string.  Default is 0.
  506.  
  507. Printer initialization - Enter an optional string of code (#),bytes to send to 
  508.     the printer before each print job, to set default margins, print modes etc.
  509.     (NOTE: the ^KP command has an option to specify additional codes at print 
  510.     time.  See PRINTING.)
  511. Printer deinitialization - Enter another string (#),bytes to send to the 
  512.     printer after each print job, to restore printer to desired state on exit.
  513. Proportional printing - Enter the codes needed to set your printer for 
  514.     proportional printing, when ^OJ is engaged, and then to turn this off.  
  515.     Both strings are entered as (#),bytes.
  516.  
  517. Codes for toggles (on/off) - For six of the seven printer toggles (not ^X), 
  518.     you need to tell VDE the codes to send to your printer to produce the 
  519.     desired effect, then turn it off again.  The conventional meanings of the 
  520.     toggles are:      ^B  boldface         ^Y  italic/ribbon
  521.                       ^D  doublestrike     ^T  superscript
  522.                       ^S  underline        ^V  subscript
  523.     but you can use them for anything you want.  Example: IBM/Epson printers 
  524.     require three-byte sequences to turn continuous underlining on and off:
  525.            Underline on    Esc - 1     hex 1B 2D 31   dec 27 45 49
  526.                     off    Esc - 0         1B 2D 30       27 45 48
  527.     You would enter the hex data, starting with the byte count:
  528.               Underline (^PS) on [07]:  (03)1B2D31
  529.                       ...and off [07]:  (03)1B2D30
  530.     You should find the necessary ASCII hex codes in your printer manual.
  531.          (NOTES: ^PS will underline text by overstriking with "_" if you do 
  532.     not install printer codes for it.  The ^PX toggle, for strikeout, requires 
  533.     no installation at all.)
  534.  
  535. Codes for switches - The same idea, but for switches, which send the same 
  536.     codes every time they are used.  WordStar calls the switches:
  537.          ^P^Q  user1  \
  538.            ^W  user2   \ (no standard      ^A  alternate pitch
  539.            ^E  user3   /  meaning)         ^N  normal pitch
  540.            ^R  user4  /
  541.     but once again, you can use them for anything you want: fonts, etc.
  542.  
  543.  
  544. --------------------------  D. DEFAULT MACRO KEYS  ---------------------------
  545.  
  546.  
  547.      VDE has a set of 36 Macro Keys (available in command mode only!), corres- 
  548. ponding to the commands Esc0...9 and EscA...Z.  The default macro definitions 
  549. are those attached to these commands when VDE is first entered.  By changing 
  550. them you can configure VDE to suit your own specialized writing requirements.  
  551. (Any Keys defined with Esc] while using VDE override these defaults.)
  552.      VINSTALL can use Key Definition files to store macro key sets.  These 
  553. should have a file type of ".VDK", for ease of identification.  You have the 
  554. option to read in or write out such a file, as well as editing the keys 
  555. individually.  (VDK files can also be read or saved with VDE's AltU command, 
  556. but only VINSTALL can display the definitions.)
  557.      VINSTALL gives you a display much like this:
  558.  
  559.       Macro Keys:  (___ bytes free)      <---- note room (up to 982)
  560.       [Esc0]<>
  561.       [Esc1]<>                           <---- "<>" flag means empty
  562.       [Esc2]<>
  563.       [Esc3]^[;^C                        <---- normal macro key
  564.       [Esc4]<>
  565.       [Esc5]<N>World Wide Widgets Inc.   <---- "<N>" flag means no-rpt key
  566.       [Esc6]<>
  567.       [Esc7]<Q>^QR^KB^QC^KK^KC           <---- "<Q>" flag means quiet key
  568.       [Esc8]<>
  569.       [Esc9]<>
  570.  
  571. Just select the number of the Key you want to redefine, then type in the new 
  572. definition, much as you would in VDE.  All the same rules apply (but VINSTALL 
  573. will accept longer keys, up to 128 bytes).  If the new definition is too long 
  574. to fit it will be rejected.
  575.      There are several different ranges of keys, which can be displayed and 
  576. modified in a range of 10 at a time (for example, keys 0-9, or A-J).
  577.      VDE.ARC comes with a macro key file EXAMPLES.VDK, containing these
  578. example macros taken from the VDE manual:
  579.  
  580.      [Esc1]<Q>^QR^NAltD^OF
  581.      [Esc2]<Q>^[~.1^S^[1^[~.<^[2^D^[= 2^[=^M2
  582.      [Esc3]<Q>^QS^X^[=^M]^S^V ^V^D^[![
  583.      [Esc4]<Q>^S^[~ 2^[1^G^S^[= 1^[2^G^S^[~ 2^D
  584.  
  585. These are: Put date at top right of file; Move to start of current sentence; 
  586. Soften a hard-CR paragraph; Delete word left.  (Note "Esc" displays "^[".)
  587.  
  588.  
  589. -------------------------  E. DEFAULT FUNCTION KEYS  -------------------------
  590.  
  591.  
  592.      VDE also has a set of 40 Function Keys (available in command mode only!), 
  593. corresponding to the [F1]...[F10] keys in their normal, Shift-, Ctrl-, and 
  594. Alt- usage (sometimes referred to collectively as [F1]...[F40]).  These are 
  595. identical in features and functions to the Macro Keys discussed above.  You 
  596. can easily configure these to match the standard function-key configuration 
  597. for Wordstar's key overlay, to correspond to Word Perfect function-key usage, 
  598. or in any other way you like.
  599.      VINSTALL can use Function Key Definition files to store function-key 
  600. sets.  These should have a file type of ".VDF", for ease of identification.  
  601. You have the option to read in or write out such a file, as well as editing 
  602. the keys individually.  (VDF files can also be read or written with VDE's AltU 
  603. command, but only VINSTALL can display the definitions.)
  604.      VINSTALL gives you a display much like this:
  605.  
  606.       Function keys 1-10:  (___ bytes free)   <---- note room (up to 982)
  607.       [F1]<>
  608.       [F2]<>                                  <---- "<>" flag means empty
  609.       [F3]<>
  610.       [F4]<Q>^OL5^M^OR60^M                    <---- normal function key
  611.       [F5]<>
  612.       [F6]<>
  613.       [F7]<>
  614.       [F8]<>
  615.       [F9]<Q>^PS
  616.       [F0]<Q>^PY
  617.  
  618. This works just like the macro keys above, with four sets of 10 keys to define 
  619. (Normal, Shift, Ctrl, Alt).
  620.      VDE.ARC includes sample function-key files which you can read in to 
  621. define the function keys according to the usage of WordStar or Word Perfect.  
  622. The WordStar 4 default definitions in WS4.VDF are:
  623.  
  624. WS4.VDF      NORMAL      SHIFT        CTRL             ALT
  625.      [F1]     ^J          ^OB          ^QF         Vertical bar graphic
  626.      [F2]     ^U          ^OC          ^QA         Horizontal bar
  627.      [F3]     ^V^PS^V                  ^L          Upper-left corner
  628.      [F4]     ^V^PB^V                  ^QI         Upper-right corner
  629.      [F5]     ^Y          ^KY          ^OL         Lower-left corner
  630.      [F6]     ^T          ^KU          ^OR         Lower-right corner
  631.      [F7]                 ^KV                      Upper T graphic
  632.      [F8]                 ^KC                      Lower T
  633.      [F9]     ^KS         ^KB          ^QS         Left T
  634.      [F0]     ^KD         ^KK          ^QD         Right T
  635.  
  636. The WP.VDF file will not "turn VDE into Word Perfect", but it does provide a 
  637. considerable degree of keystroke compatibility.  You can assign any other 
  638. functions desired to unused keys (eg, [F9]).
  639.  
  640. WP.VDF       NORMAL      SHIFT        CTRL             ALT
  641.      [F1]     ^U         Esc?Y        AltR
  642.      [F2]     ^QF                                      ^QA
  643.      [F3]     ^J                      Esc?C            ^OD
  644.      [F4]    ^I^OL^M                  Esc?B           Esc?B
  645.      [F5]     ^KF        AltD                          ^PZ
  646.      [F6]    ^V^PB^V      ^OC                          ^OF
  647.      [F7]    Esc?E       Esc?P
  648.      [F8]    ^V^PS^V     Esc?T        Esc?S           Esc?S
  649.      [F9]
  650.      [F0]     ^KS        Esc?F        Esc[
  651.  
  652.  
  653.  
  654. --------------------------  F. GRAPHICS CHARACTERS  --------------------------
  655.  
  656.  
  657.      VDE's handling of graphics assumes an IBM compatible PC.  However, it may 
  658. work usefully for other MSDOS computers, if your video system supports a set 
  659. of extra characters for ASCII codes with the high bit set.
  660.      VDE allows text to contain a limited, but variable, set of 32 IBM 
  661. graphics characters in the range 80-FFh (see GRAPHICS).  VINSTALL lets you 
  662. specify your own default graphics set.  Keep a fair amount of space free in it 
  663. if you frequently work with files with different graphics characters, in order 
  664. to avoid overflowing the table.
  665.  
  666.      You will be shown the current definitions, in the same format as the VDE 
  667. Graphics command.  Here, however, you can select any entry to redefine (A-Z, 
  668. 1-5) whether vacant or not; furthermore, you may type "-" to clear them all.  
  669. (Graphic 6 cannot be changed; it always remains a fuzzy blob.)  In VINSTALL, 
  670. new graphic codes must be entered by hex value, from 80 to FF; a full list of 
  671. graphics characters can be displayed for your selection if you need it, by 
  672. typing "?".  An entry of 00 (or simply pressing [Ret]) means "free" or 
  673. undefined.
  674.      Note that your Printer Installation determines how graphics will print.
  675.  
  676.  
  677.  
  678. ---------------------------  G. RESTORE DEFAULTS  ----------------------------
  679.  
  680.  
  681.      This option on the VINSTALL menu is provided in the event that you want 
  682. to undo any changes that you (or someone else) has made to your copy of VDE.  
  683. This should return VDE to the state it was distributed in: installation for 
  684. IBM PC, all User Options restored to their defaults, printer driver set to 
  685. Simple, no Macro or Function Keys, original Graphics characters.
  686.  
  687.  
  688.  
  689.  
  690. -----------------------------------[end]--------------------------------------
  691.  
  692.          ---  Eric Meyer, 401 12th Ave SE #139, Norman OK 73071  ---
  693.  
  694. ==============================================================================
  695.